home *** CD-ROM | disk | FTP | other *** search
/ Mega Doom 1 / Mega Doom 1.iso / utils / defram10 / deframed.txt < prev    next >
Text File  |  1994-06-29  |  4KB  |  123 lines
  1. Deframed v. 1.0 
  2. By Chris Gillespie
  3. gilles2@hubcap.clemson.edu
  4.  
  5.     Deframed v. 1.0 is a very crude utility to extract the frame table from
  6. the registered version 1.2 of DOOM.EXE.  Patch files can be created in text
  7. or binary format, edited and written back to DOOM.EXE.  Deframed must reside
  8. in the directory with DOOM.EXE.
  9.  
  10.     Disclaimer:  The author is not responsible for any damage this software
  11. causes to the DOOM.EXE file or any other software, files, or hardware.
  12.  
  13.     If you have problems with DEFRAMED, contact me via email at 
  14. gilles2@hubcap.clemson.edu.
  15.  
  16.  
  17. Text Patch File Format
  18. ----------------------
  19.  
  20.     The first thing in a text patch file is a .FORVERSION line, indicating
  21. what version of DOOM the patch file is meant to be used with.  Only DOOM
  22. version 1.2 is supported.
  23.  
  24.     Following the version number are the entries from the frame table.
  25. The first line specifying an entry has a $ symbol in the first column,
  26. followed by the entry number (0-511).  On a new line after the entry
  27. are seven unsigned 4-byte integers.  The meaning of these integers is
  28. explained in Matt Fell's Doom Specs.  As a side note, the fourth integer
  29. is actually two 2-byte integers, but I was too lazy to split it apart :-).
  30.  
  31.     Text files do not have to contain the ENTIRE frame table.  It may only
  32. contain a few entries and the entry # next the $ symbol will be used as
  33. an index into the frame table.
  34.  
  35.  
  36. Binary Patch File Format
  37. ------------------------
  38.  
  39.     Deframed can also produce binary patch files.  The first four bytes of
  40. a binary patch file contain the float value for the version of DOOM the
  41. patch file is for and the remaining bytes contain the raw frame table
  42. data extracted from DOOM.EXE.
  43.  
  44.  
  45.  
  46. Usage
  47. -----
  48.  
  49.     When using deframed, the names of text file patches must have the
  50. extension, .FRT, and the names of binary file patches muse have the 
  51. extension, .FRB.  If no file extension are specified, these extensions
  52. are added automatically based on the option being used (it is assumed 
  53. that binary files have .FRB for an extension and text files use .FRT).
  54.  
  55. THE EXTENSION NAME IS THE ONLY ERROR CHECKING DONE TO VERIFY WHETHER A
  56. PATCH FILE IS BINARY OR TEXT.
  57.  
  58.  
  59.  
  60. Example Uses:
  61.  
  62.     deframed -cb binpatch txtpatch
  63.  
  64.         Converts a binary patch file named BINPATCH.FRB to a text patch file
  65.         named TXTPATCH.FRT
  66.  
  67.  
  68.     deframed -ct txtpatch binpatch
  69.     
  70.         Converts a text patch file named TXTPATCH.FRT to a binary patch file
  71.         named BINPATCH.FRT.  
  72.  
  73.         Note:  If the text file is not a complete list of frame table entries,
  74.                it is combined with the frame table in DOOM.EXE for conversion.
  75.  
  76.  
  77.     deframed -e txtpatch 18 31
  78.  
  79.         Extracts entries 18 through 31 in the frame table of DOOM.EXE and
  80.         APPENDS them to a text patch file called TXTPATCH.FRT.  The -e option
  81.         only works for text patch files.  Valid entry ranges for DOOM 1.2
  82.         are 0 through 511.
  83.  
  84.  
  85.     deframed -pb binpatch 
  86.  
  87.         Patches DOOM.EXE with the binary patch file named BINPATCH.FRB.
  88.  
  89.  
  90.     deframed -pt txtpatch
  91.  
  92.         Patches DOOM.EXE with the text patch file named TXTPATCH.FRT.
  93.  
  94.  
  95.     deframed -rb binpatch
  96.  
  97.         Retrieves a binary patch file named BINPATCH.FRB from DOOM.EXE.
  98.  
  99.  
  100.     deframed -rt txtpatch
  101.  
  102.         Retrieves a complete text patch file named TXTPATCH.FRT from DOOM.EXE.
  103.  
  104.  
  105.     deframed -rt txtpatch -con
  106.  
  107.         The -con option creates text patch files in a more condensed format,
  108.         uliminating some of the extra spacing.
  109.  
  110. NOTE: DEFRAMED does not protect against overwrites.
  111.  
  112.  
  113. I do not plan to release future versions; I'm hoping Greg Lewis's DEHACKED 
  114. will support frame-table editing in the future :-).
  115.  
  116.  
  117.  
  118. Credits
  119. -------
  120.  
  121.     Thanks to Matt Fell (matt.burnett@acebbs.com) who produced the specs that
  122. made editing the frame table possible.
  123.